home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / lstgen15.zip / LISTGEN.DOC < prev    next >
Text File  |  1992-07-17  |  7KB  |  148 lines
  1.              --------------------------------------------
  2.              A L L  F I L E S  L I S T  G E N E R A T O R
  3.              --------------------------------------------
  4.  
  5. Welcome to Crazy Quilts All Files List Generator.
  6.  
  7.  
  8. PURPOSE
  9. -------
  10. FileGen is designed to take all your files list (i.e. Files.BBS)
  11. and merge them into one allfiles.Lst.  Once it has done this, it will
  12. pass control to the archiver of your choice to archive this list and
  13. place it where you want it.
  14.  
  15.  
  16. INSTALLATION
  17. ------------
  18. Installation is simple, simply create or edit the control file included,
  19. pass it to LISTGEN on the command line and you are in business.
  20.  
  21.  
  22. CONTROL FILE
  23. ------------
  24. To operate, ListGen needs a control file.  This file is extremely easy
  25. to set up and you can set up multiple control files to generate multiple
  26. lists as you please.  The control file is a simple text file.
  27.  
  28.   The first line of the text file should have your name (SYSOPs Full
  29.   Name) as you want it to appear at the end of the list (when registered).
  30.  
  31.   The second line should be the name of your BBS.
  32.  
  33.   The third line must have the name of the header file you want FileGen
  34.   to place at the beginning of your list (probably something identifying
  35.   your BBS).
  36.  
  37.   The fourth line is the name of the list you want it to create (this is
  38.   the name of the list before it is archives, i.e. AllFiles.Lst).
  39.  
  40.   The fifth line is made up of two parameters seperated by a space.  The
  41.   first is the full path and name to your archiver, the second is the
  42.   command line you want to pass to your archiver.
  43.  
  44.   The sixth line is for your Registeration number. If you have not
  45.   registered, leave it zeroed out or put whatever you want there.
  46.  
  47.   The remaining lines are made up of three parameters, each seperated by
  48.   a space (1) The name of a file list to include, (2) The title you want
  49.   FileGen to insert before the listing in that directory, (3) The full
  50.   path to where the file list is located. Following is an example, do
  51.   not include any of the comments:
  52.  
  53. Armando Caceres        <-- Your name (must be same as in registeration form)
  54. The treeHOUSE BBS      <-- Name of your BBS
  55. C:\Text\treeLogo.txt   <-- This is the name of the header file
  56. treeList.Lst           <-- This is the name of the list ListGen will make
  57. C:\Utils\Arj.exe a C:\BBS\treelist.arj treelist.lst  <-- Command line to execute archiver.
  58. 0000000000             <-- Registration number (leave 0's if not registered).
  59. Files.BBS Windows_Utilities C:\BBS\FILES\WINUtil
  60. Files.BBS MultiMedia_For_Windows C:\BBS\FILES\WINMM
  61. Files.TD  MultiMedia_For_Macintosh C:\BBS\FILES\MacMM
  62. etc...
  63.  
  64. Please note that each paramater is seperated by a space.  Use
  65. underscores if you want to include spaces.  Also, notice that each
  66. directory will be scanned in the order you list them here.  Again, you
  67. can make multiple control files and then pass each to FileGen to create
  68. multiple AllFiles lists.  Just remember to give each of your list a
  69. different name or ListGen will overwrite them.
  70.  
  71. ------------------------------------------------------------------------------
  72.  
  73. ListGen can be run from a .BAT file as part of your nightly maintenance.
  74. This will keep your allfiles lists up-to-date and you never have to
  75. worry about it again.
  76.  
  77. I have included a sample control file as part of this archive (this will
  78. only work on my system, unless you happen to have the same directories
  79. set up as I do).  You can use it as a template if you like, or just
  80. delete it and save some disk space.
  81.  
  82. One more note, notice that I didn't put a trailing back slash on the path
  83. statements.  You can do it either way, but it works faster if you leave
  84. it off.  Also, you can list as many file lists as you want (200, 600,
  85. 1000, it makes no difference).  But do not leave any empty lines
  86. anywhere in the file.  If an empty line is encountered that will signal
  87. ListGen that it has reached the end of the file and ListGen will exit.
  88.  
  89.  
  90. PERFORMANCE and LIMITATIONS
  91. ---------------------------
  92. Please notice that ListGen is fully functional and lets you customize
  93. your own header.  This is unusual in unregistered versions of programs.
  94. Instead, I chose to insert a delay between the time the list is
  95. generated and when it is passed to your archiver. By registering you can
  96. eliminate this annoying pause before the archiver takes over (this delay
  97. is better then not allowing custom header files huh?). Since most people
  98. will run ListGen in their nightly batch they will forget about the delay
  99. thus probably forget to register the program so I added a reminder at
  100. the end of your list.  Once registered, this reminder will no longer be
  101. there and your lists will be completely clean.
  102.  
  103. ListGen is designed to work with the archiver of your choice.  You will
  104. need to have one if you want to archive your allfiles list.  If you want
  105. to sort your lists before generating the AllFiles list, let me recommend
  106. FLSort. FLSort is extremely fast (the fastest I have seen) and works
  107. great with ListGen.
  108.  
  109. The following Crazy Quilts files are available from me @ 1:3812/30
  110.  
  111. Magic Name   Size      Speed          Description
  112. -------------------------------------------------------------------
  113. Profiler     37K       9600 V42bis    Let your users enter their profiles.
  114. FLSort       12K       9600 V42bis    Sorts your files lists.
  115. ListGen      12K       9600 V42bis    Generates AllFiles lists.
  116.  
  117. WARRANTY
  118. --------
  119. ListGen is guaranteed to do nothing except take up a tiny bit of disk
  120. space.  Crazy Quilts Software and Armando Caceres are not responsible
  121. for any damages, loss of money or income, or any other thing that
  122. happens as a result of using this software.  Use this software at your
  123. own risk.
  124.  
  125. SUPPORT
  126. -------
  127. If you have any questions, comments, suggestions or need to get a hold
  128. of me for any reason, I can be reached at my BBS:  The treeHOUSE BBS
  129. (409) 297-5466 or (409) 297-5609.  You can also net mail me via FidoNet
  130. @ 1:3812/30, OurNet 65:214/7, SigNet 26:1409/30, or TexNet 50:1409/500.
  131.  
  132.  
  133. COPYRIGHT NOTICE
  134. ----------------
  135. ListGen (All Files List Generator) is copyrighted by Crazy Quilts
  136. Software and Armando Caceres.  You have the right to use this software
  137. free of charge for a period not to exceed 30 days.  After that time
  138. period has expired, you must either register this software or remove it
  139. from your system and discard it.  You may not use it after the 30 day
  140. period (give me a break, huh?).
  141.  
  142. That's it!  If you have any questions, comments, or suggestions for
  143. improving ListGen or any other Crazy Quilt product, drop me a note at
  144. FIDO 1:3812/30.  Thank you.
  145.  
  146.  
  147. Armando Caceres
  148.